Skip to content

Draft: Organise notebooks into website content #28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Draft
alanmlewis wants to merge 7 commits into
base: master
Choose a base branch
from
Draft

Draft: Organise notebooks into website content #28

alanmlewis wants to merge 7 commits into from

Conversation

@alanmlewis
Copy link
Collaborator

@alanmlewis alanmlewis commented May 27, 2025

Hi Andrew and @m-rivera , this is my first go at organising the notebooks into something visible on the website. They will need a lot of standardisation; we'll need to think about the best way to approach that. This PR shouldn't be merged until at least some progress on that is made, although I think I'm happy to publish with some TODO stuff still listed.

Also, I have a couple of specific questions:

  1. Is there a way to get Jupyter book to essentially ignore code errors and continue anyway? There's a few places where people have written debugging exercises, but then nothing later in the notebook actually runs.
  2. How do we want people to be able to contribute to this further? After we've done some standardisation, we'll want them to update the standardised version, not the original. I guess we'll just need some instructions on how to pull the updated version to their fork and then where to find their notebook that they've worked on.

@alanmlewis alanmlewis requested a review from arm61 May 27, 2025 16:16
@alanmlewis alanmlewis marked this pull request as draft May 27, 2025 16:16
arm61
arm61 reviewed May 27, 2025
View reviewed changes
Copy link
Contributor

@arm61 arm61 left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For (1), I have updated the yml.

@arm61
Copy link
Contributor

arm61 commented May 27, 2025

I guess we'll just need some instructions on how to pull the updated version to their fork and then where to find their notebook that they've worked on

Yes.

@arm61
Copy link
Contributor

arm61 commented Jun 18, 2025

Looks like you might have forgotten to clear all outputs?

@m-rivera
Copy link
Contributor

m-rivera commented Jul 1, 2025

Hi all!

Just working on this now. A couple of questions:

  • I see that we copied all the notebooks instead of git mv, which loses track of the authorship. I guess the original authors can still point to their first commits to prove their contribution. Are we ok with that or shall I try to do some repo management to recover the full history (preserving @alanmlewis 's new edits)?
  • Have we got the ordered table of lessons that we allocated in York (or equivalently, is that what is in _toc.yml)?
  • Shall we use GitHub Issues to call dibs on any lessons we're working on at the moment?

@alanmlewis
Copy link
Collaborator Author

alanmlewis commented Jul 7, 2025

Hi @m-rivera,

  • Yes, sorry about that. I didn't want to lose the originals, because we will have to take some stuff out in order to standardise, but that's lost the authorship track. I think it's probably OK - as you say people can still point to the initial commits (and make future commits if they want!).
  • Yes, that's what's in _toc.yml.
  • Yes, I'll create issues for each lesson now.

I'll probably do some of this this afternoon and tomorrow - please let me know what you're working on so I know what to avoid!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@arm61 arm61 arm61 left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@alanmlewis @arm61 @m-rivera